ElevenLabs KMP/dev.yveskalume.elevenlabs.stt

Package-level declarations

Types

RealtimeSttAudioFormat

enum RealtimeSttAudioFormat : Enum<RealtimeSttAudioFormat>

Encoding and sample rate of audio sent to a realtime transcription session.

RealtimeSttCommitStrategy

enum RealtimeSttCommitStrategy : Enum<RealtimeSttCommitStrategy>

Determines when buffered realtime audio is committed for transcription.

RealtimeSttEvent

sealed interface RealtimeSttEvent

Event emitted by a RealtimeSttSession.

RealtimeSttOptions

data class RealtimeSttOptions(val modelId: String = "scribe_v2_realtime", val audioFormat: RealtimeSttAudioFormat = RealtimeSttAudioFormat.Pcm16000, val languageCode: String? = null, val secondaryLanguages: List<String> = emptyList(), val commitStrategy: RealtimeSttCommitStrategy = RealtimeSttCommitStrategy.Manual, val includeTimestamps: Boolean = false, val includeLanguageDetection: Boolean = false, val keyterms: List<String> = emptyList(), val noVerbatim: Boolean = false, val enableLogging: Boolean = true)

Configuration applied when opening a realtime speech-to-text connection.

RealtimeSttSession

interface RealtimeSttSession

A controllable realtime speech-to-text WebSocket session.

SpeechToTextApi

interface SpeechToTextApi

Transcribes complete files and realtime audio streams.

SpeechToTextAuthorization

sealed interface SpeechToTextAuthorization

Credentials used for batch or realtime speech-to-text operations.

SpeechToTextFileFormat

enum SpeechToTextFileFormat : Enum<SpeechToTextFileFormat>

Format hint for a batch speech-to-text upload.

SpeechToTextRequest

data class SpeechToTextRequest(val audio: ByteArray, val fileName: String = "audio.mp3", val contentType: String = "audio/mpeg", val modelId: String = "scribe_v2", val languageCode: String? = null, val tagAudioEvents: Boolean = true, val numberOfSpeakers: Int? = null, val timestampsGranularity: TimestampsGranularity = TimestampsGranularity.Word, val diarize: Boolean = false, val fileFormat: SpeechToTextFileFormat = SpeechToTextFileFormat.Other, val enableLogging: Boolean = true)

Input for transcribing one complete audio or video file.

SpeechToTextTokenProvider

fun interface SpeechToTextTokenProvider

Supplies single-use credentials for speech-to-text operations.

TimestampsGranularity

enum TimestampsGranularity : Enum<TimestampsGranularity>

Timestamp detail requested for a batch transcription.

Transcription

data class Transcription(val languageCode: String?, val languageProbability: Double?, val text: String, val words: List<TranscriptionWord>)

Result of a batch speech-to-text request.

TranscriptionWord

data class TranscriptionWord(val text: String, val startSeconds: Double?, val endSeconds: Double?, val type: String, val speakerId: String?, val logProbability: Double?, val channelIndex: Int?)

A timestamped unit in a transcription.